Embed API Objects

The following are the main objects presented in the Embed API.

  • PyramidEmbedClient - The main embed client. This object manages the lifecycle of the embed content.
  • EmbedOptions- This object represents the embed request selections that are submitted when initializing an embed object
    • QuickEmbedOptions- This object extends EmbedOptions, offering a simplified mechanism to initialize embed objects.
  • Filter - This object represents one or more filters that can be attached to embedded content requests
  • Target - This object represents one or more targets that can be attached to embedded 'Present' content requests
  • EmbeddedResult- This object represents the embed result from embedding content
    • Query - this object represents the query objects inside the EmbeddedResult object
    • Hierarchy - this object represents the hierarchy objects inside the Query object
    • Member - this object represents the member objects inside the Hierarchy object